vcStatisticsManager

vcStatisticsManager is used by a vcSimulation object for defining the sampling rate at which interval based statistics are recorded during a simulation.

See in: Overview

Module: vcBehaviors

Parent: vcObject

Children -

Referenced by: vcWorld.StatisticsManager

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
IsEnabledBooleanRWGets or sets value that indicates if statistics manager will be initialized every time simulation starts.
By default this value is set to True.
StatisticsIntervalRealRWGets or sets the statistics interval used by simulation for recording interval based statistics.
See more
The default rate is 60.0 seconds, so an interval is recorded every 60 seconds in simulation.

Exceptions:
RuntimeException: when given new value is negative or equal to zero.

Events

Learn how to use events here. The events are also inherited from the parent class.

NameParametersDescription
OnStatisticsIntervalChangedfloat newIntervalTriggered when StatisticsInterval was changed.

Parameters:
newInterval (float): New statistics interval value.